<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_prepare_cursor</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.1.2 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Interface Functions"
HREF="spi-interface.html"><LINK
REL="PREVIOUS"
TITLE="SPI_prepare"
HREF="spi-spi-prepare.html"><LINK
REL="NEXT"
TITLE="SPI_prepare_params"
HREF="spi-spi-prepare-params.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2011-12-01T22:07:59"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.1.2 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SPI_prepare"
HREF="spi-spi-prepare.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="SPI_prepare_params"
HREF="spi-spi-prepare-params.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-PREPARE-CURSOR"
></A
>SPI_prepare_cursor</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN57632"
></A
><H2
>Name</H2
>SPI_prepare_cursor&nbsp;--&nbsp;prepare a plan for a command, without executing it yet</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN57637"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>SPIPlanPtr SPI_prepare_cursor(const char * <TT
CLASS="PARAMETER"
>command</TT
>, int <TT
CLASS="PARAMETER"
>nargs</TT
>,
                              Oid * <TT
CLASS="PARAMETER"
>argtypes</TT
>, int <TT
CLASS="PARAMETER"
>cursorOptions</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN57643"
></A
><H2
>Description</H2
><P
>   <CODE
CLASS="FUNCTION"
>SPI_prepare_cursor</CODE
> is identical to
   <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>, except that it also allows specification
   of the planner's <SPAN
CLASS="QUOTE"
>"cursor options"</SPAN
> parameter.  This is a bit mask
   having the values shown in <TT
CLASS="FILENAME"
>nodes/parsenodes.h</TT
>
   for the <TT
CLASS="STRUCTFIELD"
>options</TT
> field of <TT
CLASS="STRUCTNAME"
>DeclareCursorStmt</TT
>.
   <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
> always takes the cursor options as zero.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN57653"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>const char * <TT
CLASS="PARAMETER"
>command</TT
></TT
></DT
><DD
><P
>      command string
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>int <TT
CLASS="PARAMETER"
>nargs</TT
></TT
></DT
><DD
><P
>      number of input parameters (<TT
CLASS="LITERAL"
>$1</TT
>, <TT
CLASS="LITERAL"
>$2</TT
>, etc.)
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>Oid * <TT
CLASS="PARAMETER"
>argtypes</TT
></TT
></DT
><DD
><P
>      pointer to an array containing the <ACRONYM
CLASS="ACRONYM"
>OID</ACRONYM
>s of
      the data types of the parameters
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>int <TT
CLASS="PARAMETER"
>cursorOptions</TT
></TT
></DT
><DD
><P
>      integer bit mask of cursor options; zero produces default behavior
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN57683"
></A
><H2
>Return Value</H2
><P
>   <CODE
CLASS="FUNCTION"
>SPI_prepare_cursor</CODE
> has the same return conventions as
   <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN57688"
></A
><H2
>Notes</H2
><P
>   Useful bits to set in <TT
CLASS="PARAMETER"
>cursorOptions</TT
> include
   <TT
CLASS="SYMBOL"
>CURSOR_OPT_SCROLL</TT
>,
   <TT
CLASS="SYMBOL"
>CURSOR_OPT_NO_SCROLL</TT
>, and
   <TT
CLASS="SYMBOL"
>CURSOR_OPT_FAST_PLAN</TT
>.  Note in particular that
   <TT
CLASS="SYMBOL"
>CURSOR_OPT_HOLD</TT
> is ignored.
  </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-spi-prepare.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="spi-spi-prepare-params.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_prepare</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SPI_prepare_params</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>